//////////////////////////////////////////////////////////////////////////////////
//
// ActionScript 3.0 Common Code Library (MIT License)
// Copyright (c) 2009 AS3CommonCode | Tony Birleffi | http://www.mosaiceye.com
// 
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
// The following people are credited with originating all or parts of this code:
// FlashDoctors | flashdoctors.sourceforge.net
//
//////////////////////////////////////////////////////////////////////////////////

package org.as3commoncode.collections 
{
	import org.as3commoncode.collections.IIterable;	
	import org.as3commoncode.collections.ICollection;
	
	/**
	 * The interface class for AbstractCollection.
	 * 
	 * @see	org.as3commoncode.collections.IIterable;
	 * @author Tony Birleffi
	 */
	public interface ICollection extends IIterable
	{
		/**
		 * Set the collection to an array.
		 * 
		 * @return Array.
		 */
		function toArray():Array;
		
		/**
		 * If the collection is empty.
		 * 
		 * @return Boolean.
		 */
		function isEmpty():Boolean;
		
		/**
		 * Contains the object.
		 * 
		 * @param obj	Object.
		 * @return Boolean.
		 */
		function contains(obj:Object):Boolean;
		
		/**
		 * Contains all in the collection list.
		 * 
		 * @return Boolean.
		 */
		function containsAll(list:ICollection):Boolean;
		
		/**
		 * Add an item to the collection.
		 * 
		 * @param obj	Object.
		 */
		function addItem(obj:Object):void;
		
		/**
		 * Add an entire collection list.
		 * 
		 * @param list	ICollection.
		 */
		function addAll(list:ICollection):void;
		
		/**
		 * Remove the object from the collection.
		 * 
		 * @param obj	Object.
		 */
		function remove(obj:Object):void;
		
		/**
		 * Clear out the collection.
		 */
		function clear():void;
		
		/**
		 * Returns the size of the collection.
		 * 
		 * @return int;
		 */
		function size():int;
		
		/**
		 * Remove all from the collection list.
		 * 
		 * @param list	ICollection.
		 */
		function removeAll(list:ICollection):void;
		
		/**
		 * Retain all from the collection list.
		 * 
		 * @param list	ICollection.
		 */
		function retainAll(list:ICollection):void;
		
		/**
		 * A string representation.
		 * 
		 * @return String.
		 */
		function toString():String;
	}
}